home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / tools / czesc_3 / pfortune / fortune.doc < prev   
Text File  |  1993-09-18  |  3KB  |  96 lines
  1.  
  2.                              Peti's Fortune Manual
  3.  
  4.  
  5.                        Copyright (C) 1993 by Peter Simons
  6.                               All rights reserved.
  7.  
  8.  
  9.     Fortune is Freeware, meaning you may spread and use it without any
  10. limitations or fees. But all rights are reserved to me and I may decide to
  11. release future versions as shareware or even as part of a commercial
  12. package.
  13.  
  14.  
  15.  
  16.                                  What is it?
  17.                                  -----------
  18.  
  19.     Fortune is a small utility for your entertainment. It's only purpose is
  20. to randomly choose a line out of a text database and to display it on the
  21. screen. Usually, these databases contain funny things like Murphy's Laws
  22. and similar things. Fortune can be used to show you a different gag each
  23. time you boot your machine or it can append a sentence to each Usenet
  24. posting you write, there are no limitations.
  25.  
  26.  
  27.  
  28.                                 Installation
  29.                                 ------------
  30.  
  31.     All you have to do to install Fortune properly is to copy the
  32. executable somewhere into your command path, usually 'C:'. Additionally,
  33. you should copy the included demo database ('s/fortune.data') to your 'S:'
  34. directory, where Fortune expects it as default.
  35.  
  36.     Version 2 of PFortune uses (and requires) the PTool.Library, so be
  37. shure to copy the file to your "libs:" directory. A brief documentation on
  38. the PTool.Library functions should be available on AmiNet.
  39.  
  40.     If you use Fortune very often, you should add the line 'resident
  41. Fortune' to your startup-sequence or user-startup script, what will speed
  42. up the whole process a little bit. (See your system-software manual for
  43. further details on the resident command.)
  44.  
  45.  
  46.                              Commandline Usage
  47.                              -----------------
  48.  
  49.     If the database has been copied to 'S:', Fortune can be started without
  50. any parameters. But if you want Fortune to use another database or just
  51. want to store it in another place, you have to provide the path to the
  52. textfile via commandline.
  53.  
  54. Example: "Fortune UULIB:MyNewFortuneData"
  55.  
  56.  
  57.  
  58.                                 The database
  59.                                 ------------
  60.  
  61.     You can edit the database using every standard text editor. The format
  62. is the following:
  63.  
  64. # a comment-line
  65. fortune1
  66. fortune2
  67. fortune3
  68.  fortune3
  69.  fortune3
  70. fortune4
  71.  
  72.     The first line of the file is a comment and won't be used by Fortune.
  73. Then every line is taken as one fortune.  If you need several lines for one
  74. fortune, you have to indent the text with a blank beginning with the second
  75. line. The next fortune has to start at the first column again.
  76.  
  77.  
  78.  
  79.                              System requirements
  80.                              -------------------
  81.  
  82. Fortune doesn't need any special configuration.
  83.  
  84.  
  85.                                   Feedback
  86.                                   --------
  87.  
  88.     If you want to contact me (e-mail preferred), you may use the following
  89. addresses:
  90.  
  91.     Snail-Mail: Peter Simons        E-Mail: simons@peti.GUN.de (Usenet)
  92.                 Europaring 20
  93.                 53123 Bonn          Voice-no: +49 228 746061
  94.                 Germany
  95.  
  96.